/*
 * @(#)Specification.java   09/10/15
 * 
 * Copyright (C) 2009 Ecole des Mines d'Ales
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Contact: yulinz88@gmail.com
 */



/**
 *
 */
package fr.ema.arch3d.model.architecture.specification;

import fr.ema.arch3d.model.architecture.textADL.ADLDoc;

import java.util.List;

import backup.AbstractArchitectureBehavior;

//~--- interfaces -------------------------------------------------------------

/**
 * The  <code>Specification</code> interface supplies a useful operations to modify the specification.
 *
 * @version    version 11 oct. 2009
 * @author     Huaxi (Yulin) ZHANG
 */
public interface Specification {

    /**
     * Insert the component role into the specification
     * @param cmpRole the inserted component role
     */
    public void insertCmpRole(AbstractComponentRole cmpRole);

    /**
     * Insert the connection into the specification
     * @param connection the inserted connection
     */
    void insertConnection(AbstractConnection connection);

    /**
     * Insert the architecture behavior into the specification
     * @param archBeh the inserted architecture behavior
     */
    void insertArchBeh(String archBeh);

    /**
     * Remove the architecture behavior from the specification
     * @param archBeh the removed architecture behavior
     */
    void removeArchBeh(AbstractArchitectureBehavior archBeh);

    /**
     * Remove the component role from the specification
     * @param cmpRole the removed component role
     */
    void removeCmpRole(AbstractComponentRole cmpRole);

    /**
     * Remove the connection from the specification
     * @param connection the removed connection
     */
    void removeConnection(AbstractConnection connection);

    /**
     * Get component roles in specification
     * @return the list of component roles
     */
    List<AbstractComponentRole> getCmpRoleList();

    /**
     * Get connections in specification
     * @return the list of connections
     */
    List<AbstractConnection> getConnectionList();

    /**
     * Get architecture behaviors in specification
     * @return the list of architecture behaviors
     */
    List<AbstractArchitectureBehavior> getArchBehList();

    /**
     * Getter of the property <tt>doc</tt>
     *
     * @return  the doc
     */
    ADLDoc getDoc();

    /**
     * Setter of the property <tt>doc</tt>
     *
     * @param doc  the doc to set
     */
    void setDoc(ADLDoc doc);
    /**
     * Getter of the property <tt>name</tt>
     *
     * @return  the name
     */
    public String getName() ;

    /**
     * Setter of the property <tt>name</tt>
     *
     * @param name  the name to set
     */
    public void setName(String name) ;
}
